﻿// Copyright © 2015 onwards, Andrew Whewell
// All rights reserved.
//
// Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
//    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
//    * Neither the name of the author nor the names of the program's contributors may be used to endorse or promote products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OF THE SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace VirtualRadar.Interface
{
    /// <summary>
    /// The interface for an object that can batch up lookups of aircraft details from an online source.
    /// </summary>
    /// <remarks><para>
    /// Implementations are expected to batch up ICAOs and send them off to an online source for lookup. Once the
    /// online source replies they raise <see cref="AircraftFetched"/> with the results.
    /// </para><para>
    /// Implementations must honour the lookup aircraft details setting
    /// (<see cref="VirtualRadar.Interface.Settings.BaseStationSettings"/>.LookupAircraftDetailsOnline).
    /// </para></remarks>
    public interface IAircraftOnlineLookup : ISingleton<IAircraftOnlineLookup>
    {
        /// <summary>
        /// Gets or sets the provider that will perform lookups for us.
        /// </summary>
        IAircraftOnlineLookupProvider Provider { get; set; }

        /// <summary>
        /// Raised when the online source replies with the results of a lookup.
        /// </summary>
        event EventHandler<AircraftOnlineLookupEventArgs> AircraftFetched;

        /// <summary>
        /// Initialises the provider if it has not already been initialised.
        /// </summary>
        void InitialiseProvider();

        /// <summary>
        /// Adds the lookup of the requested ICAO to the next batch to be sent.
        /// </summary>
        /// <param name="icao"></param>
        void Lookup(string icao);

        /// <summary>
        /// Adds the lookup of multiple ICAOs to the next batch to be sent.
        /// </summary>
        /// <param name="icaos"></param>
        void LookupMany(IEnumerable<string> icaos);
    }
}
